api/payments/{id} (Get)

Get	api/payments/{id}

In This Topic

Resource Path: /sites/{company-id}/api/payments/{id}

Uri: https://secure.ontime360.com/sites/{company-id}/api/payments/{id}

Description

Retrieves a single Payment object assigned to a given identifier.

Parameters

Name	Description	Data Type
id	The unique identifier of a Payment as a Guid.	string

200 Response

The response body is of type Payment.

Returns a comprehensive Payment object.

Payment

Represents a comprehensive Payment record within the OnTime API.

Customer : string

The unique Guid identifier referencing the Customer record assigned to this Payment.

Invoice : string

The unique Guid identifier referencing the Invoice record assigned to this Payment.

ID : string

The unique identifier for this Payment record.

Amount : number

The amount that this Payment will deduct from the remaining balance of the assigned Invoice.

Date : string

The date this Payment was generated and applied to an Invoice.

Memo : string

Any additional comments associated with this Payment.

ReferenceNumber : string

The reference number assigned to this Payment.

TransferredToQuickBooksDesktop : boolean

Indicates if this Payment has been exported to QuickBooks via OnTime Management Suite.

Fault Responses

Fault	Description
400	Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information.
401	Authorization key is invalid or no longer exists.
403	Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information.